GET students/{userIdentifier}/bookings/notEnded?classTypes[0]={classTypes[0]}&classTypes[1]={classTypes[1]}

Authorization

Access to this endpoint is granted if all following conditions are true:

  • Authenticated user passes at least one of the following conditions: Authenticated user matches identifier given in "userIdentifier, studentIdentifier" uri parameter. Authenticated user is a staff member and is assigned to the same center as a user who matches identifier given in "userIdentifier, studentIdentifier" uri parameter. Authenticated user is a staff member and is assigned to the online center as a user who matches identifier given in "userIdentifier, studentIdentifier" uri parameter. Authenticated user matches identifier given in "userIdentifier, studentIdentifier" uri parameter.
  • Authenticated user who is either StaffMember, Student

Request Information

URI Parameters

NameDescriptionTypeAdditional information
userIdentifier

PearsonEnglish.LearningServices.Business.Helpers.UserIdentifier

Required

classTypes

Collection of PearsonEnglish.LearningServices.Core.Models.Enums.ClassTypes

Required

Body Parameters

None.

Response Information

Resource Description

Collection of PearsonEnglish.LearningServices.Wse.Models.StudentsBookedClassWithMaterialUrl
NameDescriptionTypeAdditional information
BookingId

globally unique identifier

None.

ClassId

globally unique identifier

None.

ClassType

integer

None.

IsOnline

boolean

None.

RefClassId

string

None.

ClassUnit

integer

None.

StartDate

date

None.

Duration

integer

None.

EndDate

date

None.

BookMode

PearsonEnglish.LearningServices.Core.Models.Enums.BookModes

None.

ClassTypeName

string

None.

CancelAvailable

boolean

None.

Description

string

None.

CenterId

globally unique identifier

None.

CenterName

string

None.

MaterialsUrl

string

None.

IsTechnologyEnabledCenter

boolean

None.

IsZoomEnabledCenter

boolean

None.

IsScheduledInOnlineCenter

boolean

None.

StandbyNotificationType

PearsonEnglish.LearningServices.Core.Models.Enums.StandbyNotificationType

None.

BookModeModifiedDate

date

None.

IsStudentClassAccessed

boolean

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "BookingId": "077afd11-65c1-403d-abd8-9913a218ff9f",
    "ClassId": "6d98f244-5dec-4600-9a37-d793ff6b464a",
    "ClassType": 3,
    "IsOnline": true,
    "RefClassId": "sample string 4",
    "ClassUnit": 1,
    "StartDate": "2024-10-05T09:16:34.9785482+00:00",
    "Duration": 6,
    "EndDate": "2024-10-05T09:16:34.9785482+00:00",
    "BookMode": 0,
    "ClassTypeName": "sample string 8",
    "CancelAvailable": true,
    "Description": "sample string 10",
    "CenterId": "da4d3c95-a01f-41ee-b254-d40c0657b51a",
    "CenterName": "sample string 12",
    "MaterialsUrl": "sample string 13",
    "IsTechnologyEnabledCenter": true,
    "IsZoomEnabledCenter": true,
    "IsScheduledInOnlineCenter": true,
    "StandbyNotificationType": 1,
    "BookModeModifiedDate": "2024-10-05T09:16:34.9971324+00:00",
    "IsStudentClassAccessed": true
  },
  {
    "BookingId": "077afd11-65c1-403d-abd8-9913a218ff9f",
    "ClassId": "6d98f244-5dec-4600-9a37-d793ff6b464a",
    "ClassType": 3,
    "IsOnline": true,
    "RefClassId": "sample string 4",
    "ClassUnit": 1,
    "StartDate": "2024-10-05T09:16:34.9785482+00:00",
    "Duration": 6,
    "EndDate": "2024-10-05T09:16:34.9785482+00:00",
    "BookMode": 0,
    "ClassTypeName": "sample string 8",
    "CancelAvailable": true,
    "Description": "sample string 10",
    "CenterId": "da4d3c95-a01f-41ee-b254-d40c0657b51a",
    "CenterName": "sample string 12",
    "MaterialsUrl": "sample string 13",
    "IsTechnologyEnabledCenter": true,
    "IsZoomEnabledCenter": true,
    "IsScheduledInOnlineCenter": true,
    "StandbyNotificationType": 1,
    "BookModeModifiedDate": "2024-10-05T09:16:34.9971324+00:00",
    "IsStudentClassAccessed": true
  }
]